Title Banner

Previous Book Contents Book Index Next

Inside Macintosh: Telephony /
Chapter 5 - Telephone Manager Messages


Telephone Manager Message Summary

C Summary

Constants

Terminal Messages

enum {
   telTermHookMsg               = 0x00000001,
   telTermKeyMsg                = 0x00000002,
   telTermVolMsg                = 0x00000004,
   telTermDisplayMsg            = 0x00000008,
   telTermEnableMsg             = 0x00000010,
   telTermOpenMsg               = 0x00000020,
   telTermCloseMsg              = 0x00000040,
   telTermResetMsg              = 0x00000080,
   telTermErrorMsg              = 0x00000100,
   telTermIndHSStateChgMsg      = 0x00000200,
   telTermIndHSConnectMsg       = 0x00000400,
   telTermKeyImmMsg             = 0x00000800,
   telTermVolStateMsg           = 0x00001000,
   telTermOtherMsg              = 0x80000000,
   telAllTermMsgs               = 0x00001fff
};

Directory Number Messages

enum {
   telDNForwardMsg              = 0x00000001,
   telDNDNDMsg                  = 0x00000002,
   telDNVoiceMailMsg            = 0x00000004,
   telDNSelectedMsg             = 0x00000008,
   telDNOtherMsg                = 0x80000000,
   telAllDNMsgs                 = 0x0000000f
};

Call Appearance Messages

enum {
   telCAAlertingMsg             = 0x00000001,
   telCAOfferMsg                = 0x00000002,
   telCAProgressMsg             = 0x00000004,
   telCAOutgoingMsg             = 0x00000008,
   telCADisconnectMsg           = 0x00000010,
   telCAActiveMsg               = 0x00000020,
   telCAConferenceMsg           = 0x00000040,
   telCATransferMsg             = 0x00000080,
   telCAHoldMsg                 = 0x00000100,
   telCADigitsMsg               = 0x00000200,
   telCACallParkMsg             = 0x00000400,
   telCACallbackMsg             = 0x00000800,
   telCARejectMsg               = 0x00001000,
   telCADeflectMsg              = 0x00002000,
   telCAForwardMsg              = 0x00004000,
   telCAConferenceSplitMsg      = 0x00008000,
   telCAConferenceDropMsg       = 0x00010000,
   telCAQueuedMsg               = 0x00020000,
   telCAInUseMsg                = 0x00040000,
   telCACallPickupMsg           = 0x00080000,
   telCAPagingMsg               = 0x00100000,
   telCAIntercomMsg             = 0x00200000,
   telCAModemToneMsg            = 0x00400000,
   telCAFaxToneMsg              = 0x00800000,
   telCAIdleMsg                 = 0x01000000,
   telCASuccessiveAlertMsg      = 0x02000000,
   telCAUserUserInfoMsg         = 0x04000000,
   telCAHandOffMsg              = 0x08000000,
   telCAVoiceDetectedMsg        = 0x10000000,
   telCASilenceDetectedMsg      = 0x20000000,
   telCADigitsImmMsg            = 0x40000000,
   telCAOtherMsg                = 0x80000000,
   telAllCAMsgs                 = 0x7fffffff
};

Terminal States

enum {
   telTerminalEnabled           = 0,
   telTerminalDisabled          = 1
};

Terminal Errors

enum {
   telUnknown                   = 0,
   telTerminalHWDisconnected    = 1,
   telDeviceDriverClosed        = 2
};

Key Press Constants

enum {
   telKeyPadPress               = 1,
   telFeatureKeyPress           = 2
};
enum {
   telHangupKey                 = 1,
   telHoldKey                   = 2,
   telConferenceKey             = 3,
   telTransferKey               = 4,
   telForwardKey                = 5,
   telCallbackKey               = 6,
   telDNDKey                    = 7,
   telCallPickupKey             = 8,
   telCallParkKey               = 9,
   telCallDeflectKey            = 10,
   telVoiceMailAccessKey        = 11,
   telCallRejectKey             = 12,
   telOtherKey                  = 16
};

Call Forward Types and States

enum {
   telForwardImmediate          = 1,
   telForwardBusy               = 2,
   telForwardNoAnswer           = 3,
   telForwardBusyNA             = 4,
   telForwardTypeUnknown        = 5
};
enum {
   telForwardCleared            = 0,
   telForwardEst                = 1,
   telForwardFailed             = 2
};

Do Not Disturb States

enum {
   telDNDCleared                = 0,
   telDNDEst                    = 1,
   telDNDFailed                 = 2
};

Voice Mail Messages

enum {
   telAllVoiceMessagesRead      = 0,
   telNewVoiceMessage           = 1
};

Directory Number Selection States

enum {
   telDNDeselected              = 0,
   telDNSelected                = 1
};

Call Progress Signals

enum {
   telCAPDialTone               = 1,
   telCAPRinging                = 2,
   telCAPDialing                = 3,
   telCAPReorder                = 4,
   telCAPBusy                   = 5,
   telCAPRouted                 = 6,
   telCAPRoutedOff              = 7,
   telCAPTimeout                = 8,
   telCAPUpdate                 = 9,
   telCAPPrompt                 = 10,
   telCAPWaiting                = 11,
   telCAPCPC                    = 12,
   telCAPNoDialTone             = 13,
   telCAPUnknown                = 15,
   telCAPDialDisabled           = 16,
   telCAPBlacklistedNumber      = 17,
   telCAPForbiddenNumber        = 18,
   telCAPModemGuardTime         = 19,
   telCAPLCDetected             = 20,
   telCAPLostLC                 = 21
};

Audible Digit States

enum {
   telDigitAudible              = 0,
   telDigitNotAudible           = 1
};

Callback Activity Types

enum {
   telCallbackCleared           = 0,
   telCallbackEst               = 1,
   telCallbackNowAvail          = 2,
   telCallbackFailed            = 3,
   telCallbackDesired           = 4,
   telCallbackDesiredCleared    = 5,
   telCalledback                = 6
};

Conference Activity States

enum {
   telConferencePrepFailed      = 0,
   telConferencePending         = 1,
   telConferenceEstFailed       = 2,
   telConferenceEst             = 3
};

Conference Drop States

enum {
   telConferenceDropFailed      = 0,
   telConferenceDropped         = 1
};

Conference Split States

enum {
   telConferenceSplitFailed     = 0,
   telConferenceSplitEst        = 1
};

Call Deflect Messages

enum {
   telCallDeflectFailed         = 0,
   telCallDeflectEst            = 1,
   telCallDeflectRecall         = 2,
   telCallDeflected             = 3,
   telAutoDeflectImmediate      = 4,
   telAutoDeflectBusy           = 5,
   telAutoDeflectNoAnswer       = 6
};

Disconnect Location Messages

enum {
   telLocalDisconnect           = 0,
   telRemoteDisconnect          = 1
};

Disconnect Types

enum {
   telCADNormal                 = 1,
   telCADBusy                   = 2,
   telCADNoResponse             = 3,
   telCADRejected               = 4,
   telCADNumberChanged          = 5,
   telCADInvalidDest            = 6,
   telCADFacilityRejected       = 7,
   telCADUnobtainableDest       = 9,
   telCADCongested              = 10,
   telCADIncompatibleDest       = 11,
   telCADTimeout                = 12,
   telCADUnknown                = 15
};

Fax Tone States

enum {
   telFaxToneDetected           = 0,
   telFaxToneCleared            = 1
};

Modem Tone States

enum {
   telModemToneDetected         = 0,
   telModemToneCleared          = 1
};

Hold States

enum {
   telHoldCleared               = 0,
   telHoldEst                   = 1,
   telHoldFailed                = 2
};

Intercom States

enum {
   telIntercomEst               = 0,
   telIntercomComplete          = 1,
   telIntercomFailed            = 2
};

Paging States

enum {
   telPageEst                   = 0,
   telPageComplete              = 1,
   telPageFailed                = 2
};

MADN In-Use States

enum {
   telInUsePrivate              = 0,
   telInUseCanAccess            = 1,
   telInUseCanMakePrivate       = 2,
   telInUseCleared              = 3
};

Outgoing Origination States

enum {
   telPhysical                  = 0,
   telProgrammatic              = 1
};

Call Parking States

enum {
   telCallParkEst               = 1,
   telCallParkRetrieveEst       = 2,
   telCallParkFailed            = 3,
   telCallParkRetrieveFailed    = 4,
   telCallParkRecall            = 5
};

Call Pickup States

enum {
   telCallPickupEst             = 0,
   telCallPickupFailed          = 1,
   telCallPickedUp              = 2
};

Call Rejection States

enum {
   telCallRejectFailed          = 0,
   telCallRejectEst             = 1,
   telCallRejected              = 2
};

Call Transfer States

enum {
   telTransferPrepFailed        = 0,
   telTransferPending           = 1,
   telTransferEst               = 2,
   telTransferFailed            = 3,
   telTransferred               = 4
};

Data Types

Call Appearance Conference Message Structure

struct CAConfMsgRec {
   TELCAHandle                  relatedCA;
};
typedef struct CAConfMsgRec CAConfMsgRec;

Call Appearance Generic Message Structure

struct CAGenericMsgRec {
   StringPtr                    rmtDN;
   StringPtr                    rmtName;
   StringPtr                    rmtSubaddress;
   short                        dialType;
};
typedef struct CAGenericMsgRec CAGenericMsgRec;

Call Appearance Transfer Message Structure

struct CATransfMsgRec {
   StringPtr                    rmtDN;
   StringPtr                    rmtName;
   StringPtr                    rmtSubaddress;
   short                        dialType;
   TELCAHandle                  prepCA;
};
typedef struct CATransfMsgRec CATransfMsgRec;

Call Appearance User-To-User Information Message Structure

struct CAUserUserInfoMsgRec {
   StringPtr                    userUserInfo;
};
typedef struct CAUserUserInfoMsgRec CAUserUserInfoMsgRec;

Telephone Manager Message Functions

Determining Which Messages a Telephone Tool Supports

pascal TELErr TELTermEventsSupp(TELHandle hTEL, long *eventMask);
pascal TELErr TELDNEventsSupp  (TELDNHandle hTELDN, long *eventMask);
pascal TELErr TELCAEventsSupp  (TELDNHandle hTELDN, long *eventMask);

Registering Message Handlers

pascal TELErr TELTermMsgHand   (TELHandle hTEL,
                                long eventMask,
                                TelephoneTermMsgUPP msgProc, 
                                long globals);
pascal TELErr TELDNMsgHand     (TELDNHandle hTELDN,
                                Boolean allDNs,
                                long eventMask,
                                TelephoneDNMsgUPP msgProc,
                                long globals);
pascal TELErr TELCAMsgHand     (TELDNHandle hTELDN,
                                long eventMask, 
                                TelephoneCAMsgUPP msgProc,
                                long globals);

Clearing Message Handlers

pascal TELErr TELClrTermMsgHand(TELHandle hTEL, 
                                TelephoneTermMsgUPP msgProc);
pascal TELErr TELClrDNMsgHand  (TELDNHandle hTELDN, 
                                TelephoneDNMsgUPP msgProc);
pascal TELErr TELClrCAMsgHand  (TELDNHandle hTELDN, 
                                TelephoneCAMsgUPP msgProc);

Application-Defined Message Functions

pascal void MyTermMsgHandler   (TELHandle hTEL, 
                                long msg, 
                                short mtype, 
                                short value, 
                                long globals);
pascal void MyDNMsgHandler     (TELDNHandle hTELDN, 
                                long msg, 
                                short mtype, 
                                short value, 
                                ConstStr255Param rmtDN, 
                                ConstStr255Param rmtName, 
                                ConstStr255Param rmtSubaddress, 
                                long globals);
pascal void MyCAMsgHandler     (TELCAHandle hTELCA, 
                                long msg, 
                                short mtype, 
                                short value, 
                                Ptr msgInfo, 
                                long globals);

Pascal Summary

Constants

Terminal Messages

CONST
   telTermHookMsg               = $00000001;
   telTermKeyMsg                = $00000002;
   telTermVolMsg                = $00000004;
   telTermDisplayMsg            = $00000008;
   telTermEnableMsg             = $00000010;
   telTermOpenMsg               = $00000020;
   telTermCloseMsg              = $00000040;
   telTermResetMsg              = $00000080;
   telTermErrorMsg              = $00000100;
   telTermIndHSStateChgMsg      = $00000200;
   telTermIndHSConnectMsg       = $00000400;
   telTermKeyImmMsg             = $00000800;
   telTermVolStateMsg           = $00001000;
   telTermOtherMsg              = $80000000;
   telAllTermMsgs               = $00001FFF;

Directory Number Messages

CONST
   telDNForwardMsg              = $00000001;
   telDNDNDMsg                  = $00000002;
   telDNVoiceMailMsg            = $00000004;
   telDNSelectedMsg             = $00000008;
   telDNOtherMsg                = $80000000;
   telAllDNMsgs                 = $0000000F;

Call Appearance Messages

CONST
   telCAAlertingMsg             = $00000001;
   telCAOfferMsg                = $00000002;
   telCAProgressMsg             = $00000004;
   telCAOutgoingMsg             = $00000008;
   telCADisconnectMsg           = $00000010;
   telCAActiveMsg               = $00000020;
   telCAConferenceMsg           = $00000040;
   telCATransferMsg             = $00000080;
   telCAHoldMsg                 = $00000100;
   telCADigitsMsg               = $00000200;
   telCACallParkMsg             = $00000400;
   telCACallbackMsg             = $00000800;
   telCARejectMsg               = $00001000;
   telCADeflectMsg              = $00002000;
   telCAForwardMsg              = $00004000;
   telCAConferenceSplitMsg      = $00008000;
   telCAConferenceDropMsg       = $00010000;
   telCAQueuedMsg               = $00020000;
   telCAInUseMsg                = $00040000;
   telCACallPickupMsg           = $00080000;
   telCAPagingMsg               = $00100000;
   telCAIntercomMsg             = $00200000;
   telCAModemToneMsg            = $00400000;
   telCAFaxToneMsg              = $00800000;
   telCAIdleMsg                 = $01000000;
   telCASuccessiveAlertMsg      = $02000000;
   telCAUserUserInfoMsg         = $04000000;
   telCAHandOffMsg              = $08000000;
   telCAVoiceDetectedMsg        = $10000000;
   telCASilenceDetectedMsg      = $20000000;
   telCADigitsImmMsg            = $40000000;
   telCAOtherMsg                = $80000000;
   telAllCAMsgs                 = $7FFFFFFF;

Terminal States

CONST
   telTerminalEnabled           = 0;
   telTerminalDisabled          = 1;

Terminal Errors

CONST
   telUnknown                   = 0;
   telTerminalHWDisconnected    = 1;
   telDeviceDriverClosed        = 2;

Key Press Constants

CONST
   telKeyPadPress               = 1;
   telFeatureKeyPress           = 2;
CONST
   telHangupKey                 = 1;
   telHoldKey                   = 2;
   telConferenceKey             = 3;
   telTransferKey               = 4;
   telForwardKey                = 5;
   telCallbackKey               = 6;
   telDNDKey                    = 7;
   telCallPickupKey             = 8;
   telCallParkKey               = 9;
   telCallDeflectKey            = 10;
   telVoiceMailAccessKey        = 11;
   telCallRejectKey             = 12;
   telOtherKey                  = 16;

Call Forward Types and States

CONST
   telForwardImmediate          = 1;
   telForwardBusy               = 2;
   telForwardNoAnswer           = 3;
   telForwardBusyNA             = 4;
   telForwardTypeUnknown        = 5;
CONST
   telForwardCleared            = 0;
   telForwardEst                = 1;
   telForwardFailed             = 2;

Do Not Disturb States

CONST
   telDNDCleared                = 0;
   telDNDEst                    = 1;
   telDNDFailed                 = 2;

Voice Mail Messages

CONST
   telAllVoiceMessagesRead      = 0;
   telNewVoiceMessage           = 1;

Directory Number Selection States

CONST
   telDNDeselected              = 0;
   telDNSelected                = 1;

Call Progress Signals

CONST
   telCAPDialTone               = 1;
   telCAPRinging                = 2;
   telCAPDialing                = 3;
   telCAPReorder                = 4;
   telCAPBusy                   = 5;
   telCAPRouted                 = 6;
   telCAPRoutedOff              = 7;
   telCAPTimeout                = 8;
   telCAPUpdate                 = 9;
   telCAPPrompt                 = 10;
   telCAPWaiting                = 11;
   telCAPCPC                    = 12;
   telCAPNoDialTone             = 13;
   telCAPUnknown                = 15;
   telCAPDialDisabled           = 16;
   telCAPBlacklistedNumber      = 17;
   telCAPForbiddenNumber        = 18;
   telCAPModemGuardTime         = 19;
   telCAPLCDetected             = 20;
   telCAPLostLC                 = 21;

Audible Digit States

CONST
   telDigitAudible              = 0;
   telDigitNotAudible           = 1;

Callback Activity Types

CONST
   telCallbackCleared           = 0;
   telCallbackEst               = 1;
   telCallbackNowAvail          = 2;
   telCallbackFailed            = 3;
   telCallbackDesired           = 4;
   telCallbackDesiredCleared    = 5;
   telCalledback                = 6;

Conference Activity States

CONST
   telConferencePrepFailed      = 0;
   telConferencePending         = 1;
   telConferenceEstFailed       = 2;
   telConferenceEst             = 3;

Conference Drop States

CONST
   telConferenceDropFailed      = 0;
   telConferenceDropped         = 1;

Conference Split States

CONST
   telConferenceSplitFailed     = 0;
   telConferenceSplitEst        = 1;

Call Deflect Messages

CONST
   telCallDeflectFailed         = 0;
   telCallDeflectEst            = 1;
   telCallDeflectRecall         = 2;
   telCallDeflected             = 3;
   telAutoDeflectImmediate      = 4;
   telAutoDeflectBusy           = 5;
   telAutoDeflectNoAnswer       = 6;

Disconnect Location Messages

CONST
   telLocalDisconnect           = 0;
   telRemoteDisconnect          = 1;

Disconnect Types

CONST
   telCADNormal                 = 1;
   telCADBusy                   = 2;
   telCADNoResponse             = 3;
   telCADRejected               = 4;
   telCADNumberChanged          = 5;
   telCADInvalidDest            = 6;
   telCADFacilityRejected       = 7;
   telCADUnobtainableDest       = 9;
   telCADCongested              = 10;
   telCADIncompatibleDest       = 11;
   telCADTimeout                = 12;
   telCADUnknown                = 15;

Fax Tone States

CONST
   telFaxToneDetected           = 0;
   telFaxToneCleared            = 1;

Modem Tone States

CONST

   telModemToneDetected         = 0;
   telModemToneCleared          = 1;

Hold States

CONST
   telHoldCleared               = 0;
   telHoldEst                   = 1;
   telHoldFailed                = 2;

Intercom States

CONST
   telIntercomEst               = 0;
   telIntercomComplete          = 1;
   telIntercomFailed            = 2;

Paging States

CONST
   telPageEst                   = 0;
   telPageComplete              = 1;
   telPageFailed                = 2;

MADN In-Use States

CONST
   telInUsePrivate              = 0;
   telInUseCanAccess            = 1;
   telInUseCanMakePrivate       = 2;
   telInUseCleared              = 3;

Outgoing Origination States

CONST
   telPhysical                  = 0;
   telProgrammatic              = 1;

Call Parking States

CONST
   telCallParkEst               = 1;
   telCallParkRetrieveEst       = 2;
   telCallParkFailed            = 3;
   telCallParkRetrieveFailed    = 4;
   telCallParkRecall            = 5;

Call Pickup States

CONST
   telCallPickupEst             = 0;
   telCallPickupFailed          = 1;
   telCallPickedUp              = 2;

Call Rejection States

CONST
   telCallRejectFailed          = 0;
   telCallRejectEst             = 1;
   telCallRejected              = 2;

Call Transfer States

CONST
   telTransferPrepFailed        = 0;
   telTransferPending           = 1;
   telTransferEst               = 2;
   telTransferFailed            = 3;
   telTransferred               = 4;

Data Types

Call Appearance Conference Message Structure

TYPE
   CAConfMsgRec = 
   RECORD
      relatedCA:                TELCAHandle;
   END;

Call Appearance Generic Message Structure

   CAGenericMsgRec = 
   RECORD
      rmtDN:                    StringPtr;
      rmtName:                  StringPtr;
      rmtSubaddress:            StringPtr;
      dialType:                 Integer;
   END;

Call Appearance Transfer Message Structure

   CATransfMsgRec = 
   RECORD
      rmtDN:                    StringPtr;
      rmtName:                  StringPtr;
      rmtSubaddress:            StringPtr;
      dialType:                 Integer;
      prepCA:                   TELCAHandle;
   END;

Call Appearance User-To-User Information Message Structure

   CAUserUserInfoMsgRec = 
   RECORD
      userUserInfo:             StringPtr;
   END;

Telephone Manager Message Functions

Determining Which Messages a Telephone Tool Supports

FUNCTION TELTermEventsSupp     (hTEL: TELHandle; VAR eventMask: LongInt): TELErr;
FUNCTION TELDNEventsSupp       (hTELDN: TELDNHandle; VAR eventMask: LongInt): 
                                TELErr;
FUNCTION TELCAEventsSupp       (hTELDN: TELDNHandle; VAR eventMask: LongInt): 
                                TELErr;

Registering Message Handlers

FUNCTION TELTermMsgHand        (hTEL: TELHandle; 
                                eventMask: LongInt; 
                                msgProc: ProcPtr; 
                                globals: LongInt): TELErr;
FUNCTION TELDNMsgHand          (hTELDN: TELDNHandle; 
                                allDNs: Boolean; 
                                eventMask: LongInt; 
                                msgProc: ProcPtr; 
                                globals: LongInt): TELErr;
FUNCTION TELCAMsgHand          (hTELDN: TELDNHandle; 
                                eventMask: LongInt; 
                                msgProc: ProcPtr; 
                                globals: LongInt): TELErr;

Clearing Message Handlers

FUNCTION TELClrTermMsgHand     (hTEL: TELHandle; msgProc: ProcPtr): TELErr;
FUNCTION TELClrDNMsgHand       (hTELDN: TELDNHandle; msgProc: ProcPtr): TELErr;
FUNCTION TELClrCAMsgHand       (hTELDN: TELDNHandle; msgProc: ProcPtr): TELErr;

Application-Defined Message Functions

PROCEDURE MyTermMsgHandler     (hTEL: TELHandle; 
                                msg: LongInt; 
                                mtype: Integer; 
                                value: Integer; 
                                globals: LongInt);
PROCEDURE MyDNMsgHandler       (hTELDN: TELDNHandl;, 
                                msg: LongInt; 
                                mtype: Integer; 
                                value: Integer; 
                                rmtDN: Str255; 
                                rmtName: Str255; 
                                rmtSubaddress: Str255; 
                                globals: LongInt);
PROCEDURE MyCAMsgHandler       (hTELCA: TELCAHandle; 
                                msg: LongInt; 
                                mtype: Integer; 
                                value: Integer; 
                                msgInfo: Ptr;, 
                                globals: LongInt);


Previous Book Contents Book Index Next

© Apple Computer, Inc.
13 DEC 1996



Navigation graphic, see text links

Main | Top of Section | What's New | Apple Computer, Inc. | Find It | Feedback | Help